<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>gps: E:/CODING/arduino-1.0/libraries/gps/gps_setup.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">gps
   &#160;<span id="projectnumber">1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6ef22761b4862fd593205c95f7ac3a3d.html">CODING</a></li><li class="navelem"><a class="el" href="dir_a23ad32c709cbe4d21e2bb7aa37b6a3a.html">arduino-1.0</a></li><li class="navelem"><a class="el" href="dir_c17db4ac16776378fe75e5aa45b7fade.html">libraries</a></li><li class="navelem"><a class="el" href="dir_5dae2307f95cc4f8fc1bc98b3ac5969e.html">gps</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">gps_setup.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>SETUP FILE for the GPS utility library.  
<a href="#details">More...</a></p>

<p><a href="gps__setup_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0e98ac52ba5f9f671a87ee47ca45ddf2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps__setup_8h.html#a0e98ac52ba5f9f671a87ee47ca45ddf2">PMTKCHN_ENABLE</a></td></tr>
<tr class="memdesc:a0e98ac52ba5f9f671a87ee47ca45ddf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable the $PMTKCHN functionality.  <a href="#a0e98ac52ba5f9f671a87ee47ca45ddf2"></a><br/></td></tr>
<tr class="memitem:af98456070a63f454dbd60f56a7907616"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps__setup_8h.html#af98456070a63f454dbd60f56a7907616">TOTAL_CHANNEL</a>&#160;&#160;&#160;(0)</td></tr>
<tr class="memdesc:af98456070a63f454dbd60f56a7907616"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override the total channel count.  <a href="#af98456070a63f454dbd60f56a7907616"></a><br/></td></tr>
<tr class="memitem:a9af75e27cc4e0868f069f54834cc9540"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps__setup_8h.html#a9af75e27cc4e0868f069f54834cc9540">CHECKSUM_ENABLE</a></td></tr>
<tr class="memdesc:a9af75e27cc4e0868f069f54834cc9540"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable checksum functionality.  <a href="#a9af75e27cc4e0868f069f54834cc9540"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>SETUP FILE for the GPS utility library. </p>
<p>This file is used to setup the gps utility librari. Simply remove or add the comment // to set your option. </p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a9af75e27cc4e0868f069f54834cc9540"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CHECKSUM_ENABLE</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable checksum functionality. </p>
<p>While higly recommended to be activated, you can comment this option to deactivate the checksum verification on NMEA string. When deactivated the library will still check the format of the NMEA string in this manner:</p>
<ul>
<li>string start with char $</li>
<li>string contain char * at [STRING_LENGHT - 5]</li>
<li>string finish with new line <br/>
 The only good reason to deactivate the checksum on NMEA string is to save memory on the device. </li>
</ul>

</div>
</div>
<a class="anchor" id="a0e98ac52ba5f9f671a87ee47ca45ddf2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PMTKCHN_ENABLE</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable the $PMTKCHN functionality. </p>
<p>if PMTKCHN_ENABLE is defined, the librarie will decode the $PMTKCHN message for the MTK gps channel information. The channel information is storred in the global 'channel_s struct' 'chan' array. The 'channel_s struct' contain:</p>
<ul>
<li>uint8_t svid; // Space Vehicle Id</li>
<li>uint8_t snr; // Signal to Noise Ratio</li>
<li>uint8_t status; // 0: Idle / 1: Searching / 2: Tracking </li>
</ul>

</div>
</div>
<a class="anchor" id="af98456070a63f454dbd60f56a7907616"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TOTAL_CHANNEL&#160;&#160;&#160;(0)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Override the total channel count. </p>
<p>If TOTAL_CHANNEL is defined, the default total number of channel is overrided with the defined value. Only a positive integral value is valid. 0 or bellow 0 will be set as default value. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat May 26 2012 18:48:47 for gps by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
